Skip to content

Don't publish an incomplete changelog - #910

Open
W0rma wants to merge 2 commits into
Codeception:masterfrom
W0rma:fix-changelog-partial-output
Open

W0rma wants to merge 2 commits into
Codeception:masterfrom
W0rma:fix-changelog-partial-output

Conversation

@W0rma

@W0rma W0rma commented Nov 14, 2026

Copy link
Copy Markdown
Contributor

Problem

processChangelog() silently skipped repositories whose release fetch failed. A temporary GitHub API error produced a changelog with most repositories missing. That version was published, and the next hourly run restored it.

Examples (truncated → restored):

Changes

  • Retry, then abort: failed release fetches are retried up to 3 times and logged. If a fetch keeps failing, robo changelog exits with an error before writing the file, so the publish step doesn't run and the next hourly run tries again.
  • Remove the changelog run from build:docs: that run was unauthenticated and its output was overwritten by the separate robo changelog step anyway. It only used up API rate limit.

Note

If the changelog step fails, that hour's other docs updates are published with the next successful run.

Failed release fetches were silently skipped, so a transient API error
produced a changelog with most repositories missing, which got
published and restored by the next hourly run.

Retry failed fetches and abort if they keep failing, so nothing is
written or committed.
The publish workflow runs robo changelog as a separate, authenticated
step which overwrites the result. The run in build:docs is
unauthenticated and only consumes API rate limit.
@W0rma
W0rma requested review from Arhell and TavoNiievez November 14, 2026 10:45

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant